home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgramD2.iso / Languages / MS Cobol4.5 / DOCS / TIMEOUT.DOC < prev   
Text File  |  1991-06-01  |  7KB  |  178 lines
  1.  
  2.                        TIMEOUT SUPPORT IN ACCEPT
  3.                        =========================
  4.  
  5.   Definition
  6.   ==========
  7.  
  8.   General Format
  9.  
  10.  
  11.   For both Format 1 and Format 2 of the ACCEPT statement as documented in
  12.   the Screen Handling chapter of the Language Reference, the following
  13.   additional phrase is provided.
  14.  
  15.   +------------------------------------------------------------------------+
  16.   |                                                                        |
  17.   |           { TIME-OUT  }        { integer-7    }                        |
  18.   |           { --------  }        {              }                        |
  19.   |           {           } AFTER  {              }                        |
  20.   |           {           }        {              }                        |
  21.   |           { TIMEOUT   }        { identifier-8 }                        |
  22.   |           { -------   }        {              }                        |
  23.   |                                                                        |
  24.   +------------------------------------------------------------------------+
  25.  
  26.   Syntax Rules
  27.  
  28.   1.  Identifier-8 must be an integer.  It may be signed.  If unsigned it is
  29.       treated as positive.
  30.  
  31.   2.  Integer-7 must be an integer which may optionally be signed.  If
  32.       unsigned it is treated as positive.
  33.  
  34.  
  35.   General Rules
  36.  
  37.   1.  If identifier-8 or integer-7 has a negative value, this represents a
  38.       request that no time-out "exception" should occur no matter how long
  39.       there is between/before key-strokes.
  40.  
  41.   2.  If identifier-8 or integer-7 is zero, this indicates that a time-out
  42.       should not occur if characters are waiting. However, if no characters
  43.       are waiting (when the ACCEPT is processed), then issue a time-out
  44.       immediately.
  45.  
  46.   3.  The ON EXCEPTION clause, if present, will be executed when a Time-Out
  47.       occurs and a time-out clause is specified.  The NOT ON EXCEPTION
  48.       clause, if present, will be executed when a Time-Out clause is specified
  49.       but no time-out (or other exception) occurs.
  50.  
  51.   4.  If a Time-Out exception occurs, then the contents of any ACCEPT
  52.       resultant-field will be defined as follows:
  53.  
  54.       a.  Any field which has been partially modified will contain any
  55.           information which has already been received.
  56.       b.  Fields which have "FULL" or "REQUIRED" attributes or any other
  57.           attribute which would normally impact partial field input, will NOT
  58.           be required to meet those attributes when a partial field entry has
  59.           occurred when a TIMEOUT exception occurs.
  60.       c.  The rules listed above apply whether or not the timeout clock is
  61.           reset upon each keystroke.
  62.  
  63.   5.  If at run-time a positive timeout interval greater than 2,147,483,647
  64.       hundredths of a second is detected the timeout value will be reset to
  65.       2,147,483,647 hundredths of a seconds (which is approximately eight
  66.       months).
  67.  
  68.   6.  The Time-Out value specifies the number of seconds (or tenths of a
  69.       second) after the ACCEPT statement begins processes until a time-out
  70.       exception occurs.  A new ADISCF configuration option controls
  71.       whether or not the TIMEOUT clock is "reset" each time a new keyboard
  72.       action is detected.  An application which wants some ACCEPT statements
  73.       to be handled with a RESET and some without, may make specific CALLs
  74.       to the ADIS run-time interface before or after the ACCEPT statements
  75.       that need changes from the default.  For example when ADIS was
  76.       configured not to do resets, if a program had:
  77.  
  78.         ACCEPT INPUT-FIELD RIME-OUT AFTER +10
  79.  
  80.       Then a time-out would occur after 10 seconds had elapsed from the
  81.       beginning of the ACCEPT, even if some characters were entered after 5
  82.       seconds into the ACCEPT processing.
  83.  
  84.       If, on the other hand, ADIS were configured to do resets, if a program
  85.       had the same code given above, then each time a new character were
  86.       entered, the timeout "clock" would be reset to zero.
  87.  
  88.    8. If a Time-Out exception occurs and no On Exception phrase is specified,
  89.       then the CRT Status keys (if specified) are updated, the application
  90.       continues to the logically next phrase, and the contents of the ACCEPT
  91.       receiving field are as defined above.  (The above is true whether or not
  92.       a NOT ON EXCEPTION phrase is specified.)
  93.  
  94.    9. All references to (NOT) ON EXCEPTION phrases within this proposal also
  95.       apply to (NOT) ON ESCAPE phrases.
  96.  
  97.  
  98.  
  99.   Running
  100.   =======
  101.  
  102.   Configuring the TIMEOUT options using ADISCF
  103.   --------------------------------------------
  104.   Two new Accept/Display options are available in ADISCF to allow
  105.   configuration of TIMEOUT. They are as follows:
  106.  
  107.   Option 31 - Selection of the units used when calculating TIMEOUT on
  108.               an accept.
  109.  
  110.               1 - Units used are seconds
  111.  
  112.               2 - Units used are tenths of a second
  113.  
  114.  
  115.   Option 32 - Control of the timer used to calculate accept TIMEOUT.
  116.  
  117.               1 - The timer is never reset. Timeout will occur
  118.                   at the specified length of time after the accept is
  119.                   initiated
  120.  
  121.               2 - Timeout is reset to its original value each time a
  122.                   character is entered.
  123.  
  124.  
  125.   Changing the TIMEOUT options at run-time
  126.   ----------------------------------------
  127.   Two new X"AF" calls are provided to allow the TIMEOUT options shown
  128.   above to be altered at run-time. The calls have the following format
  129.  
  130.      CALL X"AF" USING Set-Bit-Pairs Parameter-Block
  131.  
  132.   where the parameters are defined as follows:
  133.  
  134.      01 Set-Bit-Pairs              PIC 9(2) COMP-X VALUE 1.
  135.      01 Parameter-Block.
  136.        03 Bit-Pair-Setting         PIC 9(2) COMP-X.
  137.        03 FILLER                   PIC X VALUE "6".
  138.        03 Bit-Pair-Number          PIC 9(2) COMP-X.
  139.        01 FILLER                   PIC 9(2) COMP-X VALUE 1.
  140.  
  141.   The values to be set for the fields Bit-Pair-Setting and Bit-Pais-Number
  142.   are given in each of the descriptions below.
  143.  
  144.   With each call, if an error occurs, Set-Bit-Pairs will return the value
  145.   255.
  146.  
  147.  
  148.   Select Timeout units.
  149.   ---------------------
  150.   Allows selection of the units to be used when calculating TIMEOUT.
  151.  
  152.     Bit-Pair-Number must be set to 14.
  153.  
  154.     Bit-Par-Setting should be one of the following values:
  155.  
  156.       0  -   Units are seconds
  157.  
  158.       1  -   Units are tenths of a second
  159.  
  160.  
  161.   Control Timeout Reset
  162.   ---------------------
  163.   Allows control of the timer used to calculate TIMEOUT on an accept.
  164.  
  165.     Bit-Pair-Number must be set to 15.
  166.  
  167.     Bit-Par-Setting should be one of the following values:
  168.  
  169.       0  -   Timer is never reset. Timeout occurs after the specified
  170.              time from the start of the accept.
  171.  
  172.       1  -   The timer is reset each time a character is entered.
  173.  
  174.  
  175.   ==========================================================================
  176.   Copyright (C) 1991 Microsoft Corporation
  177.   Copyright (C) 1991 Micro Focus Ltd
  178.